home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / xcalenda.z / xcalenda / man / catn / xcalendar.n
Text File  |  1994-09-27  |  10KB  |  331 lines
  1.  
  2.  
  3.  
  4. xcalendar(1)             USER COMMANDS             1 October 1991
  5.  
  6.  
  7.  
  8. NAME
  9.      xcalendar - calendar with a notebook for X11
  10.  
  11. SYNTAX
  12.      xcalendar [month [year]]
  13.  
  14. DESCRIPTION
  15.      The _x_c_a_l_e_n_d_a_r is a simple interactive calendar program  with
  16.      a  notebook capability. It is built on the X Toolkit and the
  17.      Athena Widgets.
  18.  
  19.      If month and year are not provided on the command line  they
  20.      are assumed to be current.
  21.  
  22. INTERACTIONS
  23.      Clicking the left mouse button on a day will  start  a  text
  24.      editor.   You  can  edit  and  save a text.This text will be
  25.      associated with the day. You can later on read and edit this
  26.      text  when you open the editor for the same day. The text is
  27.      saved in a file in the directory ~/Calendar. The editor lets
  28.      you  also  clear  an entry associated with a particular day.
  29.      You can also scroll through days  while  in  the  editor  by
  30.      clicking on the arrows on either side of the date label.  If
  31.      an already open day is scrolled to, an  appropriate  message
  32.      is displayed and the editor is brought upin read only mode.
  33.  
  34.      It is also possible to scroll through  months  in  the  main
  35.      window  by  clicking  on  the  arrows  on either side of the
  36.      current date label.
  37.  
  38.      You can highlight all entries in a  month  by  invoking  the
  39.      function  ShowEntries.  By  default  this function is called
  40.      when the left mouse button is pressed in  the  title  window
  41.      (where  month and a year are displayed).  Pressing again the
  42.      same button will unhighlight the entries.
  43.  
  44. MISSING FEATURES
  45.      To remove all entries in a particular month you have to  use
  46.      your  system's  commands.  The  naming  scheme for the files
  47.      makes it easy : the command "rm ~/Calendar/xc*sep1988  "  on
  48.      UNIX(TM)  will  remove all entries from september 1988.  The
  49.      facility to do that from the xcalendar should be provided.
  50.  
  51.      One can imagine many  other  useful  features.  For  example
  52.      automatic  parsing  of  the  current day entry in search for
  53.      appointments to trigger alarms (reminders) at the approriate
  54.      time. Well, maybe one day...
  55.  
  56. RESOURCES
  57.      The resource data base lets you alter the visual  appearance
  58.      of the program. You can change fonts, border widths, labels,
  59.      and other  resources  used  by  widgets.  One  use  of  this
  60.  
  61.  
  62.  
  63. X Version 11                                                    1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. xcalendar(1)             USER COMMANDS             1 October 1991
  71.  
  72.  
  73.  
  74.      facility is to change names of week days and months.
  75.  
  76.      Here are the names of widgets you can  use  to  set  various
  77.      resources:
  78.  
  79.           XCalendar    - class of the application
  80.           xcalendar    - top level pane
  81.           controls     - control panel
  82.           quitButton   - quit button
  83.           helpButton   - help button
  84.           date         - date label
  85.           calendar     - calendar pane
  86.           daynumbers   - day numbers frame
  87.           1-49         - day number buttons
  88.           daynames     - day names frame
  89.           MON,TUE,WED,THU,FRI,SAT,SUN - day name buttons
  90.           helpWindow   - help window
  91.           bcontrols    - month buttons frame
  92.           prev         - previous month button
  93.           succ         - succeeding month button
  94.           cdate        - current date widget
  95.           dayEditor    - editor popup
  96.           editorFrame  - editor frame
  97.           editorTitle  - editor title
  98.           editor       - editor
  99.           daybuttons   - day buttons frame
  100.           prevday      - previous day button
  101.           succday      - succeeding day button
  102.           editorControls- control panel
  103.           doneButton   - done button
  104.           saveButton   - save button
  105.           clearEntry   - clear entry button
  106.  
  107.  
  108.      Application specific resources:
  109.  
  110.           reverseVideoMark - if True the entries are highlighted in reverse
  111.                         video;  default True for black and white,
  112.                         and False for color displays;
  113.  
  114.           setMarkBackground - if True and reverseVideoMark is False the entries
  115.                         are highlighted by setting background to
  116.                         markBackground ;
  117.  
  118.           markBackground    - background color for highlighting entries;
  119.  
  120.           setMarkForeground - analogous to setMarkBackground;
  121.  
  122.           markForeground    - foreground color for highlighting entries;
  123.  
  124.           _s_e_t_M_a_r_k_B_a_c_k_g_r_o_u_n_d and _s_e_t_M_a_r_k_F_o_r_e_g_r_o_u_n_d can take any
  125.           combination of values.
  126.  
  127.  
  128.  
  129. X Version 11                                                    2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. xcalendar(1)             USER COMMANDS             1 October 1991
  137.  
  138.  
  139.  
  140.           january,february,..,december - these resources can be used for
  141.                               changing names of months;
  142.           firstDay - an integer between 1-7,  indicating the day to start a week with,
  143.                        default:  7 (Sunday);
  144.           markOnStartup   -  if True mark the entries upon startup,
  145.                        default: False;
  146.           helpFile        -  full pathname of the xcalendar.hlp file,
  147.                        default: /usr/lib/X11/xcalendar.hlp;
  148.           textBufferSize  -  maximum size of the text buffer in the day editor,
  149.                        default: 2048;
  150.  
  151.  
  152. DEFAULT RESOURCE DATA BASE:
  153.           !
  154.           XCalendar*showGrip:      False
  155.           XCalendar*calendar*internalBorderWidth: 0
  156.           XCalendar*input:         True
  157.           XCalendar*resize: False
  158.           XCalendar*resizable: True
  159.           XCalendar.title: XCalendar v.3.0
  160.           XCalendar.dayEditor.title: Day Editor
  161.           XCalendar.helpWindow.title: XCalendar Help
  162.           XCalendar*Font: 8x13
  163.  
  164.           XCalendar*helpFile: <INSTALLDIR>/slib/X11/xcalendar/xcalendar.hlp
  165.  
  166.           XCalendar*firstDay:      7
  167.  
  168.           !bitmaps
  169.           XCalendar*prev*bitmap: <INSTALLDIR>/slib/X11/xcalendar/larrow.xbm
  170.           XCalendar*succ*bitmap: <INSTALLDIR>/slib/X11/xcalendar/rarrow.xbm
  171.           XCalendar*prevday*bitmap: <INSTALLDIR>/slib/X11/xcalendar/larrow.xbm
  172.           XCalendar*succday*bitmap: <INSTALLDIR>/slib/X11/xcalendar/rarrow.xbm
  173.           XCalendar*helpButton*bitmap: <INSTALLDIR>/slib/X11/xcalendar/qmark.xbm
  174.           XCalendar*quitButton*bitmap: <INSTALLDIR>/slib/X11/xcalendar/quit.xbm
  175.  
  176.           ! colors
  177.           ! Note: These may cause problems using the -rv option on monochrome displays
  178.           XCalendar*Background: lightgray
  179.           XCalendar*markBackground: Steel Blue
  180.           XCalendar*daynames*Background: lightgray
  181.           XCalendar*daynames.SUN*Foreground: Red
  182.           XCalendar*daynames.SAT*Foreground: Black
  183.           XCalendar*daynumbers*Foreground:   Black
  184.           XCalendar*daynumbers.1*Foreground: Red
  185.           XCalendar*daynumbers.8*Foreground: Red
  186.           XCalendar*daynumbers.15*Foreground: Red
  187.           XCalendar*daynumbers.22*Foreground: Red
  188.           XCalendar*daynumbers.29*Foreground: Red
  189.           XCalendar*daynumbers.36*Foreground: Red
  190.           XCalendar*helpButton*Background: slategray
  191.           XCalendar*helpButton*Foreground: White
  192.  
  193.  
  194.  
  195. X Version 11                                                    3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. xcalendar(1)             USER COMMANDS             1 October 1991
  203.  
  204.  
  205.  
  206.           XCalendar*quitButton*Background: slategray
  207.           XCalendar*quitButton*Foreground: White
  208.           XCalendar*editorTitle*Background: lightgray
  209.           XCalendar*editorTitle*Foreground: Black
  210.           XCalendar*editorControls*Background: lightgray
  211.           XCalendar*editorControls*Command.Background: slategray
  212.           XCalendar*editorControls*Command.Foreground: White
  213.  
  214.           XCalendar*setMarkBackground: True
  215.           XCalendar*markOnStartup: True
  216.  
  217.           XCalendar.BorderWidth:        2
  218.           XCalendar*calendar.borderWidth:    1
  219.           XCalendar*borderWidth: 0
  220.           XCalendar*date*borderWidth: 0
  221.           XCalendar*date*vertDistance: 5
  222.  
  223.           XCalendar*date*font:          8x13bold
  224.           XCalendar*daynames*font:      8x13bold
  225.           XCalendar*dayEditor*editorTitle*font: 8x13bold
  226.           XCalendar*helpWindow*editorTitle*font: 8x13bold
  227.  
  228.           XCalendar*helpButton*vertDistance: 12
  229.           XCalendar*quitButton*vertDistance: 12
  230.           XCalendar*editorTitle*vertDistance: 5
  231.  
  232.           XCalendar*editorControls*doneButton*label: Done
  233.           XCalendar*editorControls*saveButton*label: Save
  234.           XCalendar*editorControls*clearEntry*label: Clear Entry
  235.  
  236.           XCalendar*dayEditor*geometry: 300x150
  237.           XCalendar*helpWindow*geometry: 600x350
  238.  
  239.           XCalendar*doneButton*Label: done
  240.           XCalendar*editorTitle*Label: Help
  241.           XCalendar*helpButton*Label: help
  242.           XCalendar*quitButton*Label: quit
  243.           XCalendar*saveButton*Label: save
  244.  
  245.           XCalendar*bcontrols*borderWidth: 0
  246.           XCalendar*prev*highlightThickness: 0
  247.           XCalendar*succ*highlightThickness: 0
  248.  
  249.           XCalendar*prevday*highlightThickness: 0
  250.           XCalendar*succday*highlightThickness: 0
  251.           XCalendar*daybuttons*borderWidth: 0
  252.  
  253.           XCalendar*Scrollbar.borderWidth: 1
  254.           XCalendar*editor.scrollVertical: whenNeeded
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261. X Version 11                                                    4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. xcalendar(1)             USER COMMANDS             1 October 1991
  269.  
  270.  
  271.  
  272. FILES
  273.       $HOME/Calendar/*
  274.  
  275. SEE ALSO
  276.      xrdb(1)
  277.  
  278. BUGS
  279.      Save button handler in the editor cannot detect when a  text
  280.      is  pasted.  Workaround  :  type  something to the editor to
  281.      activate save button.
  282.  
  283. AUTHORS
  284.      Copyright 1988  by  Massachusetts  Institute  of  Technology
  285.      Roman J. Budzianowski, MIT Project Athena
  286.  
  287.      Copyright 1990 by Purdue University Richard Bingle, Computer
  288.      Science
  289.  
  290.      Enhancements by Beth Chaney Purdue University Computer  Sci-
  291.      ence Department
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327. X Version 11                                                    5
  328.  
  329.  
  330.  
  331.